home *** CD-ROM | disk | FTP | other *** search
/ Visual Basic Source Code / Visual Basic Source Code.iso / vbsource / vbdatabs / bstree.h < prev    next >
C/C++ Source or Header  |  1999-03-14  |  8KB  |  262 lines
  1. // ------------------------------- //
  2. // -------- Start of File -------- //
  3. // ------------------------------- //
  4. // ----------------------------------------------------------- //
  5. // C++ Header File Name: bstree.h
  6. // Compiler Used: MSVC40, DJGPP 2.7.2.1, GCC 2.7.2.1, HP CPP 10.24
  7. // Produced By: Doug Gaer   
  8. // File Creation Date: 01/23/1997 
  9. // Date Last Modified: 03/15/1999
  10. // Copyright (c) 1997 Douglas M. Gaer
  11. // ----------------------------------------------------------- // 
  12. // ---------- Include File Description and Details  ---------- // 
  13. // ----------------------------------------------------------- // 
  14. /*
  15. The VBD C++ classes are copyright (c) 1997, by Douglas M. Gaer.
  16. All those who put this code or its derivatives in a commercial
  17. product MUST mention this copyright in their documentation for
  18. users of the products in which this code or its derivative
  19. classes are used. Otherwise, you have the freedom to redistribute
  20. verbatim copies of this source code, adapt it to your specific
  21. needs, or improve the code and release your improvements to the
  22. public provided that the modified files carry prominent notices
  23. stating that you changed the files and the date of any change.
  24.  
  25. THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND.
  26. THE ENTIRE RISK OF THE QUALITY AND PERFORMANCE OF THIS SOFTWARE
  27. IS WITH YOU. SHOULD ANY ELEMENT OF THIS SOFTWARE PROVE DEFECTIVE,
  28. YOU WILL ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR
  29. CORRECTION.
  30.  
  31. This is a generic (B)inary (S)earch (T)ree. A binary search
  32. tree has binary nodes (nodes with no more then two children).
  33. The smaller nodes are stored on the left and larger nodes are
  34. stored on the right.
  35. */
  36. // ----------------------------------------------------------- //   
  37. #ifndef __BSTREE_HPP
  38. #define __BSTREE_HPP
  39.  
  40. #include "bstreeb.h"
  41. #include "twalk.h"
  42.  
  43. // (B)inary (S)earch (T)ree class
  44. template<class TYPE>
  45. class BSTree
  46. {
  47. public:
  48.   BSTree() { Root = 0; }
  49.   virtual ~BSTree() { Clear(); }
  50.   BSTree(const BSTree<TYPE> &t)  { Root = 0; Copy(t); }
  51.   void operator=(const BSTree<TYPE> &t) { if (this != &t) Copy(t); }
  52.  
  53. public:
  54.   int Copy(const BSTree<TYPE> &Tree);
  55.   int Copy(const BSTree<TYPE> &Tree, WalkOrder w);
  56.   void Clear() { DelTree(Root); Root = 0; }
  57.   BNode<TYPE> *GetMember(const TYPE &X);
  58.   const BNode<TYPE> *GetMember(const TYPE &X) const {
  59.     return ((BSTree<TYPE> *)this)->GetMember(X);
  60.   }
  61.   BNode<TYPE> *Add(const TYPE &X, int &existed);
  62.   BNode<TYPE> *Add(const TYPE &X) { int dmy; return Add(X, dmy); }
  63.   BNode<TYPE> *Detach(const TYPE &X);
  64.   BNode<TYPE> *DetachMin(); 
  65.   BNode<TYPE> *DetachMax();
  66.   int Delete(const TYPE &X);
  67.   void DeleteMin() { FreeNode(DetachMin()); }
  68.   void DeleteMax() { FreeNode(DetachMax()); }
  69.   BNode<TYPE> *GetRoot();
  70.   BNode<TYPE> *GetMin() { return (BNode<TYPE> *)Minimum(Root); }
  71.   BNode<TYPE> *GetMax() { return (BNode<TYPE> *)Maximum(Root); }
  72.   int IsEmpty() const;
  73.  
  74. protected:
  75.   BNode<TYPE> *SearchP(const TYPE &X, BNode<TYPE> *&p, int &Side);
  76.   BNode<TYPE> *DupTree(BNode<TYPE> *Tree);
  77.   virtual void FreeNode(BNode<TYPE> *n);
  78.   void DelTree(BNode<TYPE> *Tree);
  79.  
  80.   virtual BNode<TYPE> *AllocNode
  81.       (const TYPE &X, BNode<TYPE> *L=0, BNode<TYPE> *R=0);
  82.  
  83. protected:
  84.   BNode<TYPE> *Root;
  85. };
  86.  
  87. template<class TYPE>
  88. BNode<TYPE> *BSTree<TYPE>::GetMember(const TYPE &X)
  89. {
  90.   BNode<TYPE> *Tree = Root;
  91.   while (Tree) {
  92.     if (X == Tree->Data) break;
  93.     Tree = (X < Tree->Data) ? Tree->GetLeft() : Tree->GetRight();
  94.   }
  95.   return Tree; // Return pointer to node containing data X 
  96. }
  97.  
  98. template<class TYPE>
  99. BSTree<TYPE>::~BSTree()
  100. {
  101.   Clear();
  102. }
  103.  
  104. template<class TYPE>
  105. BNode<TYPE> *BSTree<TYPE>::
  106. AllocNode(const TYPE &X, BNode<TYPE> *L, BNode<TYPE> *R)
  107. {
  108.   return new BNode<TYPE>(X, L, R);
  109. }
  110.  
  111. template<class TYPE>
  112. void BSTree<TYPE>::FreeNode(BNode<TYPE> *n)
  113. {
  114.   delete n;
  115. }
  116.  
  117. template<class TYPE>
  118. BNode<TYPE> *BSTree<TYPE>
  119. ::SearchP(const TYPE &X, BNode<TYPE> *&p, int &Side)
  120. // SearchP is used to determine where the node should be added.
  121. // Passes back parent of the node found and which side the child is on.
  122. // (If matching node is the Root, a 0 is returned for p.)
  123. {
  124.   BNode<TYPE> *Tree = Root;
  125.   p = 0;
  126.   while (Tree) {
  127.     // Assumes TYPE has comparison operators defined.
  128.     if (X == Tree->Data) break; 
  129.     p = Tree;
  130.     if (X < Tree->Data) {
  131.        Side = 0;
  132.        Tree = Tree->GetLeft();
  133.     }
  134.     else {
  135.        Side = 1;
  136.        Tree = Tree->GetRight();
  137.     }
  138.   }
  139.   return Tree; // Returns pointer to node containing data X
  140. }
  141.  
  142. template<class TYPE>
  143. BNode<TYPE> *BSTree<TYPE>::Add(const TYPE &X, int &existed)
  144. {
  145.   BNode<TYPE> *p;
  146.   int Side;
  147.  
  148.   BNode<TYPE> *Tree = SearchP(X, p, Side);
  149.  
  150.   if (Tree == 0) { // No matching node found
  151.      Tree = AllocNode(X);
  152.      if(p) {
  153.         if(Side) p->Right = Tree; else p->Left = Tree;
  154.      }
  155.      else Root = Tree; // No parent, so this must be first node
  156.      existed = 0;
  157.   }
  158.   else existed = 1;
  159.  
  160.   return Tree; // Returns pointer to the new or matching node
  161. }
  162.  
  163. template<class TYPE>
  164. BNode<TYPE> *BSTree<TYPE>::Detach(const TYPE &X)
  165. {
  166.   int Side;
  167.   BNode<TYPE> *p, *Tree;
  168.  
  169.   Tree = SearchP(X, p, Side);
  170.   return (BNode<TYPE> *)DetachNode((BNodeBase *&)Root, Tree, p, Side);
  171. }
  172.  
  173. template<class TYPE>
  174. BNode<TYPE> *BSTree<TYPE>::DetachMin()
  175. {
  176.   BNodeBase *p = ParentOfMinimum(Root);
  177.   if (p && p->Left)
  178.      return (BNode<TYPE> *)DetachNode((BNodeBase *&)Root, p->Left, p, 0);
  179.      else return (BNode<TYPE> *)DetachNode((BNodeBase *&)Root, Root, 0, 0);
  180. }
  181.  
  182. template<class TYPE>
  183. BNode<TYPE> *BSTree<TYPE>::DetachMax()
  184. {
  185.   BNodeBase *p = ParentOfMaximum(Root);
  186.   if (p && p->Right)
  187.      return (BNode<TYPE> *)DetachNode((BNodeBase *&)Root, p->Right, p, 1);
  188.      else return (BNode<TYPE> *)DetachNode((BNodeBase *&)Root, Root, 0, 0);
  189. }
  190.  
  191. template<class TYPE>
  192. int BSTree<TYPE>::Delete(const TYPE &X)
  193. {
  194.   BNode<TYPE> *n = Detach(X);
  195.   FreeNode(n);
  196.   return n != 0; // Return 1 if node found, else 0
  197. }
  198.  
  199. template<class TYPE>
  200. void BSTree<TYPE>::DelTree(BNode<TYPE> *Tree)
  201. {
  202.   if (Tree == 0) return;
  203.   DelTree(Tree->GetLeft());  // Recursive function call 
  204.   DelTree(Tree->GetRight()); // Recursive function call 
  205.   FreeNode(Tree);
  206. }
  207.  
  208. template<class TYPE>
  209. BNode<TYPE> *BSTree<TYPE>::DupTree(BNode<TYPE> *Tree)
  210. {
  211.   if (Tree == 0) return 0;
  212.   BNode<TYPE> *L = DupTree(Tree->GetLeft());  // Recursive function call 
  213.   BNode<TYPE> *R = DupTree(Tree->GetRight()); // Recursive function call 
  214.  
  215.   // Return Root of copy, or 0 if could not allocate Root
  216.   return AllocNode(Tree->Data, L, R); 
  217. }
  218.  
  219. template<class TYPE>
  220. int BSTree<TYPE>::Copy(const BSTree<TYPE> &Tree)
  221. {
  222.   Clear();
  223.   BNode<TYPE> *R = DupTree(Tree.Root);
  224.   if (R) {
  225.      Root = R;
  226.      return 1;
  227.   }
  228.   else return 0;
  229. }
  230.  
  231. template<class TYPE>
  232. int BSTree<TYPE>::Copy(const BSTree<TYPE> &Tree, WalkOrder w)
  233. {
  234.   Clear();
  235.   TreeWalker< BNode<TYPE> > tw(Tree.Root, w);
  236.   BNode<TYPE> *nxt;
  237.   while(1) {
  238.     nxt = tw.Next();
  239.     if (nxt == 0) break;
  240.     Add(nxt->Data);
  241.   }
  242.   return 1;
  243. }
  244.  
  245. template<class TYPE>
  246. BNode<TYPE> *BSTree<TYPE>::GetRoot()
  247. {
  248.   return Root;
  249. }
  250.  
  251. template<class TYPE>
  252. int BSTree<TYPE>::IsEmpty() const
  253. {
  254.   return Root == 0;
  255. }
  256.  
  257. #endif // __BSTREE_HPP
  258. // ----------------------------------------------------------- // 
  259. // ------------------------------- //
  260. // --------- End of File --------- //
  261. // ------------------------------- //
  262.